tools/docs: Fix example and default IP addresses.
authorKeir Fraser <keir.fraser@citrix.com>
Thu, 17 Jan 2008 15:13:40 +0000 (15:13 +0000)
committerKeir Fraser <keir.fraser@citrix.com>
Thu, 17 Jan 2008 15:13:40 +0000 (15:13 +0000)
commitaac518b954d087cd64e7466cda087720280d592b
tree26dcab5e5ca0da9835138fb3d9f0b1a8d0e49054
parent5564364efa48fff512edf2210d6dd71fb72a5e52
tools/docs: Fix example and default IP addresses.

In various places in documentation and code, IP addresses are provided
as examples, defaults, or dummy configuration.  In general the
specific IP addresses used in Xen are not always appropriate.  (For
example, 1.2.3.4 is used in a few places!)

The following addresses should be used:
 * For examples and documentation, 192.0.2.0/24.  (See RFC3330.)
 * For defaults for private networks, a random network from RFC1918.
   I have randomly selected 172.30.206.0/24 for this purpose and
   documented this in at the only registry I know of,
   www.ucam.org/cam-grin.  This network should henceforth be used for
   default configurations of local bridges, test networks, etc. in
   Xen tools.

The following addresses should NOT be used:
 * 10.0.*.*, 10.1.*.*, 192.168.0.*, 192.168.1.*, etc.  Using these
   addresses gives greatly increased likelihood of collision, as
   ignorant network administrators and reckless middlebox vendors
   often pick networks from the bottom of 10/8 and 192.168/16.
 * 169.254.*.*.  These are reserved for zeroconf (ad-hoc networking)
   and should not be used for Xen private networks, bridges, etc.,
   etc.  Use of these addresses by Xen scripts causes trouble on hosts
   (eg laptops) which find themselves in ad-hoc networking
   environments.  I think this is not hypothetical (!) since at least
   one Linux distribution have specific code to detect this case and
   cause Xen startup to fail iff the host already has an external
   zeroconf address.
 * 1.2.3.4.  WTF !?

I have also used 127.0.255.255 in one place where apparently a dummy
address is needed (some Linux kernels won't accept a lack of an NFS
server address).  If 127.0.255.255 is mistakenly used it is unlikely
to do any damage to real traffic even if it does escape into the
network at large.

Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
16 files changed:
docs/man/xend-config.sxp.pod.5
docs/src/user.tex
tools/examples/network-nat
tools/examples/xeninfo.pl
tools/examples/xmexample1
tools/examples/xmexample2
tools/python/xen/sv/CreateDomain.py
tools/python/xen/xm/create.py
tools/python/xen/xm/tests/test_create.py
tools/vnet/doc/man/vn.pod.1
tools/vnet/doc/vnet-xend.txt
tools/xm-test/Writing_Tests_HOWTO
tools/xm-test/configure.ac
tools/xm-test/lib/XmTestLib/NetConfig.py
tools/xm-test/tests/restore/04_restore_withdevices_pos.py
tools/xm-test/tests/xapi/03_xapi-network_pos.py